Skip to main content

Save-IMAsset

SYNOPSIS​

Downloads Immich assets to local storage

SYNTAX​

Save-IMAsset [[-Session] <ImmichSession>] [-Id] <String> [[-Key] <String>] [[-Path] <DirectoryInfo>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Downloads one or more assets from Immich to a local directory, preserving their original filenames. Supports downloading original files, thumbnails, or web-optimized versions.

EXAMPLES​

EXAMPLE 1​

Save-IMAsset -Id '550e8400-e29b-41d4-a716-446655440000' -Path 'C:\Downloads'

Downloads the specified asset to the C:\Downloads directory.

EXAMPLE 2​

Get-IMAsset -Random -Count 5 | Save-IMAsset -Path 'C:\RandomAssets'

Downloads 5 random assets to the specified directory using pipeline input.

EXAMPLE 3​

Get-IMAsset -TagId 'vacation-tag' | Save-IMAsset -Path 'C:\VacationPhotos'

Downloads all assets tagged with 'vacation-tag' to a local folder.

EXAMPLE 4​

Save-IMAsset -Id 'asset-uuid' -Path 'C:\Backup' -Key 'shared-key'

Downloads an asset using a shared link key.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

The UUID of the asset to download. Accepts pipeline input.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Key​

An optional API key for shared link access when downloading assets.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Path​

The local directory where the downloaded file will be saved. The file will retain its original filename from Immich.

Type: DirectoryInfo
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github